Form Collaboration: Replace Poxa with Action Cable #3105

sammo1235 · 2024-10-11T12:01:52Z

📝 A short description of the changes

Includes behaviour:
Two users cannot edit the same form at the same time
If one user moves on to a new section (step) of the form, then then previous section is released for editing for the next user in the queue
blocks a user from editing when they have two tabs of the same form opened.

🔗 Link to the relevant story (or stories)

Deployment implications

Remove Pusher ENV vars and setup code.
Allow action cable to talk to Redis (setup should be straightforward)

✅ Checklist

Features that cannot go live are behind a feature flag/env var or specify deploy date and open PR as draft
I have checked that commit messages make sense and explain the reasoning for each change
I have performed a self-review of my own code
I have commented my code, particularly in hard-to-understand areas
I have made corresponding changes to the documentation
I have added tests that prove my fix is effective or that my feature works
I have squashed any unnecessary or part-finished commits

🖼️ Screenshots (if appropriate - no PII/Prod data):

If you have two users logged in at once, the second one to see the form section will see this message and not be able to edit the form:

If the first user moves away from that form section, closes their tab etc, then editing should be released to the second user.

Same user opening a second tab of the same form section:

This should have a similar effect but with a slightly different warning message. The user can close either tab, and the remaining one will be able to edit.

sammo1235 · 2024-10-14T15:17:30Z

app/assets/javascripts/frontend/form-validation.js.coffee

@@ -842,7 +842,7 @@ window.FormValidation =
    qRef = question.attr("data-question_ref")
    qTitle = $.trim(question.find("h2").first().text())

-    if typeof console != "undefined"
+    if typeof console != "undefined" && false


[TODO] remove once testing is complete - this output will muddy the waters

phil-l-brockwell · 2024-12-11T11:50:58Z

app/assets/javascripts/frontend/application_collaborators/access_manager.js.coffee

-  get_member_info: (m) ->
-    return ("ID: " + m.id + ", NAME: " + m.info.name + ", JOINED AT: " + m.info.joined_at)
+  current_editor_id: () ->
+    editor_id = window.current_channel_members.split("/").find((el) => el.includes("EDITOR")).split(":")[0]


You can just reuse current_editor() here

good catch, I've updated

phil-l-brockwell · 2024-12-11T13:53:28Z

app/channels/collaborators_channel.rb

+      collaborators += "/#{user.id}:#{params["current_tab"]}:#{user.email}:#{user.full_name}"
+    end
+
+    Rails.cache.write(params["channel_name"], collaborators)


Can we just keep collaborators as an array as it should be automatically serialised? Or do we need to do it this way so we know how to unserialise it in the JS?

yeah the JS does rely on the members being separated by a slash

but if you pass in an array it must serialise it in its own way. might be neater if we depend on that instead

phil-l-brockwell · 2024-12-11T13:56:56Z

app/controllers/application_controller.rb

@@ -93,6 +94,10 @@ def should_enable_js?
    helper_method "#{award}_submission_started_deadline"
  end

+  def set_session_identifier
+    cookies["public_tab_ident"] = cookies["_qae_session#{"_development" if Rails.env.development?}"]&.first(8)


What is the first(8)?

It just gets the first 8 characters, as a way of telling the tabs apart for one user

ah so its an identifier for the tab, which is always 8 chars long?

…ng forms behaviour Implements two main behaviours using ActionCable: 1. If a second user has the same section of a form open, they cannot edit it. However if the first user closes their tab or moves on to a different section then editing rights are released to the second user. 2. If user 1 opens a second tab of the same form, they cannot edit in the second tab. They are shown a message telling them to close the tab and edit in the first tab.

sammo1235 commented Oct 14, 2024

View reviewed changes

sammo1235 force-pushed the replace-poxa-with-action-cable-spike branch 6 times, most recently from 21b863b to e021984 Compare December 10, 2024 17:03

sammo1235 changed the title ~~[SPIKE] Replace Poxa with Action Cable~~ Form Collaboration: Replace Poxa with Action Cable Dec 11, 2024

phil-l-brockwell reviewed Dec 11, 2024

View reviewed changes

sammo1235 added 4 commits December 11, 2024 15:41

Remove all pusher references and dependencies

33e7a30

Add specs for collaborators and general room channels

4235e9d

Cleanup

0adafca

sammo1235 force-pushed the replace-poxa-with-action-cable-spike branch from f87be1a to 0adafca Compare December 11, 2024 15:41

sammo1235 marked this pull request as ready for review December 11, 2024 16:10

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Form Collaboration: Replace Poxa with Action Cable #3105

Form Collaboration: Replace Poxa with Action Cable #3105

sammo1235 commented Oct 11, 2024 •

edited

Loading

sammo1235 Oct 14, 2024

phil-l-brockwell Dec 11, 2024

sammo1235 Dec 11, 2024

phil-l-brockwell Dec 11, 2024 •

edited

Loading

sammo1235 Dec 11, 2024

phil-l-brockwell Dec 11, 2024

phil-l-brockwell Dec 11, 2024

sammo1235 Dec 11, 2024

phil-l-brockwell Dec 11, 2024

Form Collaboration: Replace Poxa with Action Cable #3105

Are you sure you want to change the base?

Form Collaboration: Replace Poxa with Action Cable #3105

Conversation

sammo1235 commented Oct 11, 2024 • edited Loading

📝 A short description of the changes

🔗 Link to the relevant story (or stories)

Deployment implications

✅ Checklist

🖼️ Screenshots (if appropriate - no PII/Prod data):

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

phil-l-brockwell Dec 11, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sammo1235 commented Oct 11, 2024 •

edited

Loading

phil-l-brockwell Dec 11, 2024 •

edited

Loading